.. _cmlPmSxIsDone:

cmlPmSxIsDone
================================
--------------------------------


SYNOPSYS
`````````````
.. code-block:: none

  VT_I4 cmlPmSxIsDone ([in] VT_I4 BoardID,  [in] VT_I4 NodeId, [in] VT_I4 Channel, [out] VT_PI4 IsDone )   


DESCRIPTION
`````````````  

- cmlPmSxIsDone() 함수는 단일 축에 대하여 모션 완료를 확인합니다.

\

- 이 함수의 사용과 호출에 있어, 제공된 ㈜커미조아의 함수 헤더 Visual Basic 에서는 함수의
  첨두어 cml 가 붙지 않습니다.

PARAMETER
`````````````

▶ BoardID : 사용자가 설정한 디바이스(보드) ID. 
 
▶ NodeId : 사용자가 제어하고자 하는 노드 번호.
 
▶ Channel : 축 번호. 통합 축으로 관리되는 축 번호를 의미하며, 상수 값으로 0 (Zero Based) 이상, 최대 
통합 축 개수 - 1 이하의 값을 축 번호로 설정할 수 있습니다. 
 
▶ IsDone : 이 매개 변수를 통해 모션 작업이 완료되었는지를 판단할 수 있습니다. 

  .. csv-table::
   :widths: 10 90
   :header-rows: 1
   :stub-columns: 0

    Value, Meaning
    0 (cmlFALSE), 모션작업이 완료되지 않음. 
    1 (cmlTRUE), 모션작업이 완료 됨.


REFERENCE
```````````````

- INP 입력신호가 Enable 로 설정되었으면 Command 펄스 출력이 완료되어도 INP 입력이
  ON 이 되기 전까지는 모션이 완료되지 않은 것으로 간주되어 반환되지 않습니다. 

\

- 스텝 드라이브를 사용 중인 고객님들께서는 다음을 참조해 주십시오. 
  스텝 드라이브는 INP 출력이 없는 경우가 일반적인데, 고객님의 부주의나 잘못된 설정으로 INP 입력에 
  대한 설정이 Enable 로 되어 있을 경우 INP 입력이 스텝 드라이브를 통해 발생하지 않는 이유 때문에 모션 
  완료가 되지 않는 경우가 발생할 수 있습니다. 고객 여러분들께서는 스텝 드라이브 사용시에 이점을 
  주의하시기 바랍니다. 

\

- 서보 드라이브의 LSP , LSN 신호를 사용 중인 고객님께서는 다음을 참조해 주십시오. 
  서보드라이브의 입력 신호 중 하나인 EL(End of Limit) 신호는 저희 ㈜ 커미조아 모션 컨트롤러뿐만 
  아니라 서보드라이브에도 전달 될 수 있도록 설정할 수 있습니다. 통상적으로 LSP 신호와 LSN 신호로
  불리어 지는 이 신호는 실제 기구물에서 양의 방향(Positive Direction) 혹은 음의 방향(Negative Direction) 에 
  장착되어 있는 EL(End of Limit) 신호를 서보 드라이브 측에 전달하기 위한 용도로 사용됩니다. 

\

- 그러나, 모션 소프트웨어에서 INP 설정이 되어 있는 경우 EL 신호가 검출 된 후에 일부 서보 
  드라이브에서는 진행 방향에서 정지한 후 더 이상 움직이지 않는 상황이 발생하며, 이 상황에서 INP 
  신호가 출력되지 않아, 모션 이송이 완료되지 못하고, 명시적으로 STOP 명령을 통해 강제적으로 모션 
  종료가 되는 현상이 발생할 수 있습니다. 이 현상은 EL 모드를 통해 원점 복귀를 하는 상황에서도 발생할 
  수 있습니다.

\

- 따라서, 이러한 경우에는 반드시 원점 복귀나 EL 검출시에 인터럽트 이벤트나 타이머를 통해
  INP 를 무기한 대기하는 현상에 대해서 적절히 대처하시거나 INP 신호 사용을 배제 해야합니다.


.. note:: 윈도우 이벤트라는 것은 무엇입니까?
    윈도우 운영체제는 Event Driven 혹은 Message Driven 방식의 구조로 되어
    있습니다. 각 응용프로그램은 메시지 큐(Queue)를 가지고 있으며, 정확히
    말하면, 메시지를 사용해 이벤트를 통지하는 방식으로 설계되어 
    있습니다. 윈도우 메시지를 처리한다는 것은 메시지 큐에서 메시지를
    하나씩 꺼내서 윈도우 프로시저에 전송한다는 것을 의미하며, 이것은 그
    행선지가 되는 윈도우에 전송되어 처리됩니다.

RETURN VALUE
`````````````

+------------+-----------+
|    Value   | Meaning   |
+============+===========+
|    음수    | 수행 실패 |
+------------+-----------+
| ERR_NONE   | 수행 성공 |
+------------+-----------+

EXAMPLE
`````````

.. code-block:: c++
 :linenos:
 :emphasize-lines: 5

  C/C++ 
  #include “ComiMLink2_SDK.h” 
  #include “ComiMLink2_SDK_Def.h” 
  long BoardID = 0; 
  long nChannel = 0; //0번 축으로 설정합니다. 
  //0번 축을 현재 위치에서 10000펄스 만큼 이송합니다. 
  cmlPmSxMoveStart(BoardID, 0, nChannel, 10000 ); 
  long nIsDone = cmlFALSE; 
  while( !nIsDone ) 
  { 
  //0번 축의 모션 완료 여부를 판단합니다. 
  cmlPmSxIsDone(BoardID, 0, nChannel, &nIsDone ); 
  }

SEE ALSO
```````````

.. seealso:: :ref:`cmlPmSxWaitDone`